Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Undo the ;; deprecation #398

Merged
merged 3 commits into from
Dec 6, 2022
Merged

Undo the ;; deprecation #398

merged 3 commits into from
Dec 6, 2022

Conversation

Leonidas-from-XIV
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV commented Sep 28, 2022

As described in https://github.com/tarides/platform-roadmap/issues/45 this undoes the ;; deprecation.

CHANGES.md Outdated Show resolved Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@gpetiot gpetiot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@Leonidas-from-XIV Leonidas-from-XIV merged commit 6a7c12e into realworldocaml:main Dec 6, 2022
@Leonidas-from-XIV Leonidas-from-XIV deleted the no-semi-semi-deprecation branch December 6, 2022 14:03
Leonidas-from-XIV added a commit to Leonidas-from-XIV/opam-repository that referenced this pull request Jan 6, 2023
CHANGES:

#### Added

- Report all parsing errors in Markdown files (realworldocaml/mdx#389, @NathanReb)

#### Changed

- Preserve indentation in multiline OCaml blocks in .mli files (realworldocaml/mdx#395, @panglesd)

#### Fixed

- Fixed compatibility with Cmdliner 1.1.0 (realworldocaml/mdx#371, @Leonidas-from-XIV)
- Report errors and exit codes of toplevel directives (realworldocaml/mdx#382, @talex5,
  @Leonidas-from-XIV)
- Fix block locations in error reporting (realworldocaml/mdx#389, @NathanReb)
- Include the content of the line that features the `part-end` MDX directive in
  the output, before that line would've been dropped (realworldocaml/mdx#374, realworldocaml/mdx#387,
  @Leonidas-from-XIV)
- Handle EINTR signal on waitpid call by restarting the syscall. (realworldocaml/mdx#409, @tmcgilchrist)
- Fix parsing of multiline toplevel phrases in .mli files (realworldocaml/mdx#394, realworldocaml/mdx#397,
  @Leonidas-from-XIV)

#### Removed

- Removed warning about missing semicolons added in MDX 1.11.0 and the
  automatic insertion of semicolons in the corrected files introduced in MDX
  2.0.0. (realworldocaml/mdx#398, @Leonidas-from-XIV)
@talex5
Copy link
Contributor

talex5 commented Jan 10, 2023

https://github.com/tarides/platform-roadmap/issues/45 gives a 404 error for me. Would be good to document the reason for this change somewhere public.

@Leonidas-from-XIV
Copy link
Collaborator Author

I think it's ok to quote the roadmap item summary for a description of this change:

In a previous version of mdx, code blocks that do not end with a double semicolon (;;) have been deprecated. However, this has been criticized as creating a poor user experience, as it can make code less readable when semicolons are added to all code blocks. We want to remove this deprecation to improve the user experience of mdx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants